Fzzy Config/me.fzzyhmstrs.fzzy_config.entry/EntryCreator

EntryCreator

@ApiStatus.Experimental

fun interface EntryCreator

Handles creating DynamicListWidget.Entry, separate and distinct from a config-level Entry

Author

fzzyhmstrs

Since

0.6.0

Inheritors

Types

class Creator(val scope: String, val texts: Translatable.Result, val entry: BiFunction<DynamicListWidget, Int, out DynamicListWidget.Entry>)

Wrapper of information needed to create a new GUI entry.

class CreatorContext(val scope: String, val groups: LinkedList<String>, val client: Boolean, val texts: Translatable.Result, val annotations: List<Annotation>, val actions: Set<Action>, val misc: EntryCreator.CreatorContextMisc)

Context provided by the screen manager for building a new Creator

CreatorContextKey

open class CreatorContextKey<T>

Key for data stored in CreatorContextMisc

CreatorContextMisc

class CreatorContextMisc

Functions

abstract fun createEntry(context: EntryCreator.CreatorContext): List<EntryCreator.Creator>

Builds one or more DynamicListWidget.Entry from provided CreatorContext. These entries are used to build config GUIs, being the "building block" of the settings list.

open fun prepare(scope: String, groups: LinkedList<String>, annotations: List<Annotation>, globalAnnotations: List<Annotation>)

Called in the prepare stage of screen building to perform any necessary pre-entry-creation tasks.